/*!	 valuenoderename.cpp
**	 Template File
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2007, 2008 Chris Moore
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
*/

#ifdef USING_PCH
#	include "pch.h"
#else
#ifdef HAVE_CONFIG_H
#	include <config.h>
#endif

#include <synfig/general.h>

#include "valuenoderename.h"
#include <synfigapp/canvasinterface.h>

#include <synfigapp/localization.h>

#endif

using namespace std;
using namespace etl;
using namespace synfig;
using namespace synfigapp;
using namespace Action;

ACTION_INIT_NO_GET_LOCAL_NAME(Action::ValueNodeRename);
ACTION_SET_NAME(Action::ValueNodeRename, "ValueNodeRename");
ACTION_SET_LOCAL_NAME(Action::ValueNodeRename, N_("Rename ValueNode"));
ACTION_SET_TASK(Action::ValueNodeRename, "rename");
ACTION_SET_CATEGORY(Action::ValueNodeRename, Action::CATEGORY_VALUENODE);
ACTION_SET_PRIORITY(Action::ValueNodeRename, 0);
ACTION_SET_VERSION(Action::ValueNodeRename, "0.0");
ACTION_SET_CVS_ID(Action::ValueNodeRename, "$Id$");

Action::ValueNodeRename::ValueNodeRename()
{
}

synfig::String
Action::ValueNodeRename::get_local_name()const
{
    // TRANSLATORS: This is used in the 'history' dialog when a ValueNode is renamed.
    return strprintf(_("Rename ValueNode from '%s' to '%s'"),
                     old_name.c_str(),
                     new_name.c_str());
}

Action::ParamVocab
Action::ValueNodeRename::get_param_vocab()
{
    ParamVocab ret(Action::CanvasSpecific::get_param_vocab());

    ret.push_back(ParamDesc("value_node", Param::TYPE_VALUENODE)
                  .set_local_name(_("ValueNode_Const"))
                 );

    ret.push_back(ParamDesc("name", Param::TYPE_STRING)
                  .set_local_name(_("Name"))
                  .set_desc(_("The new name of the ValueNode"))
                  .set_user_supplied()
                  .set_value_provided()
                 );

    return ret;
}

bool
Action::ValueNodeRename::is_candidate(const ParamList &x)
{
    if (candidate_check(get_param_vocab(), x)) {
        if (x.find("value_node")->second.get_value_node()->is_exported()) {
            return true;
        }
    }

    return false;
}

bool
Action::ValueNodeRename::set_param(const synfig::String& name, const Action::Param &param)
{
    if (name == "value_node" && param.get_type() == Param::TYPE_VALUENODE) {
        value_node = param.get_value_node();

        if (value_node && !value_node->is_exported()) {
            synfig::error("Action::ValueNodeRename::set_param(): ValueBase node not exported!");
            value_node = 0;
        }

        return (bool)value_node;
    }

    if (name == "name" && param.get_type() == Param::TYPE_STRING) {
        new_name = param.get_string();

        return true;
    }

    return Action::CanvasSpecific::set_param(name, param);
}

bool
Action::ValueNodeRename::get_param(const synfig::String& name, Action::Param &param)
{
    if (name == "name") {
        param = value_node->get_id();

        return true;
    }

    return Action::CanvasSpecific::get_param(name, param);
}

bool
Action::ValueNodeRename::is_ready()const
{
    if (!value_node) {
        synfig::error("Action::ValueNodeRename::is_ready(): ValueNode not set!");
    }

    if (new_name.empty()) {
        synfig::error("Action::ValueNodeRename::is_ready(): ValueNode not set!");
    }

    if (!value_node || new_name.empty()) {
        return false;
    }

    return Action::CanvasSpecific::is_ready();
}

void
Action::ValueNodeRename::perform()
{
    assert(value_node->is_exported());

    old_name = value_node->get_id();

    if (get_canvas()->value_node_list().count(new_name)) {
        throw Error(_("A ValueNode with this ID already exists in this canvas"));
    }

    value_node->set_id(new_name);

    if (get_canvas_interface()) {
        get_canvas_interface()->signal_value_node_renamed()(value_node);
    }
}

void
Action::ValueNodeRename::undo()
{
    assert(value_node->is_exported());

    if (get_canvas()->value_node_list().count(old_name)) {
        throw Error(_("A ValueNode with the old ID already exists in this canvas (BUG)"));
    }

    value_node->set_id(old_name);

    if (get_canvas_interface()) {
        get_canvas_interface()->signal_value_node_renamed()(value_node);
    }
}